/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.ws.client;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * A GWT web socket implementation.
 * 
 * @author Marco Tamburelli
 */
public final class JsWebSocket extends JavaScriptObject
{
	/**
	 * webSocket basic event handler
	 */
	public static interface WebSocketEventHandler
	{
		/**
		 * It's called when the connection has been opened.
		 */
		void onOpen();

		/**
		 * It's called when the connection has been closed.
		 */
		void onClose();

		/**
		 * It's called when an error occurs.
		 */
		void onError();

		/**
		 * It's Called when a message has been received.
		 * 
		 * @param message The received message.
		 */
		void onMessage(String message);
	}

	protected JsWebSocket()
	{}

	public static native boolean isSupported() /*-{
		return ($wnd.WebSocket) ? true : false;
	}-*/;

	/**
	 * This method creates a JavaScript websocket extending
	 * {@link JavaScriptObject}.
	 * 
	 * TODO Maybe protocol should be declared?
	 * 
	 * @param url The service URL.
	 * @return
	 */
	public static native JsWebSocket create(String url) /*-{
		return new WebSocket(url);
	}-*/;

	public native int getReadyState() /*-{
		return this.readyState
	}-*/;

	public native int getbufferedAmount() /*-{
		return this.bufferedAmount;
	}-*/;

	public native void send(String msg) /*-{
		this.send(msg);
	}-*/;

	public native void close() /*-{
		this.close();
	}-*/;

	public native void setEventHandler(WebSocketEventHandler handler) /*-{
		this.onopen = function()
		{
			handler.@org.bmi.gwt.ws.client.JsWebSocket.WebSocketEventHandler::onOpen()();
		}
		this.onclose = function()
		{
			handler.@org.bmi.gwt.ws.client.JsWebSocket.WebSocketEventHandler::onClose()();
		}
		this.onerror = function()
		{
			handler.@org.bmi.gwt.ws.client.JsWebSocket.WebSocketEventHandler::onError()();
		}
		this.onmessage = function(response)
		{
			if (response.data) handler.@org.bmi.gwt.ws.client.JsWebSocket.WebSocketEventHandler::onMessage(Ljava/lang/String;)(response.data);
		};
	}-*/;
}
